home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 3 / CD ACTUAL 3.iso / linux / system / daemon-0.000 / daemon-0 / daemon-0.2.lsm next >
Encoding:
Text File  |  1995-08-17  |  10.8 KB  |  258 lines

  1. =============================================================================
  2. Linux Software Map Entry Template                            Release: 09AUG94
  3. =============================================================================
  4.  
  5. The LSM is a directory of information about each of the software
  6. packages available via FTP for the Linux operating system.  It is meant
  7. to be a public information resource.  All entries have been entered by
  8. volunteers all over the world via email using the template below.  New
  9. versions will appear first on sunsite.unc.edu and will be announced in
  10. the newsgroup comp.os.linux.announce .  Discussions pertaining to the
  11. LSM will be held in the newsgroup comp.os.linux.misc .  Any questions or
  12. comments can be entered in comp.os.linux.misc or sent to me directly at
  13. lars.wirzenius@helsinki.fi.
  14.  
  15. As of the end of July, 1994, the LSM is being maintained by Lars
  16. Wirzenius.  The Linux Software Map was originally conceived and
  17. maintained by Jeff Kopmanis.  As of the end of July, 1994, it is being
  18. maintained by Lars Wirzenius.  We owe Jeff a lot for making LSM the
  19. asset it is.
  20.  
  21.  
  22. =============================================================================
  23. Instructions
  24. =============================================================================
  25.  
  26. Any new packages or updates to old entries should be entered in the
  27. template below and sent to lars.wirzenius@helsinki.fi or uploaded with
  28. the package to sunsite.unc.edu.  Each release of the LSM will have the
  29. current template as part of the package.  Any changes to the template
  30. will be made and released there.
  31.  
  32. *PLEASE* use the entry template at the end when submitting information.
  33. It has been designed so that all you have to do is fill in the blanks
  34. and send it in as is.  Your entry will be read into the database
  35. directly from your email response with little if any hand manipulation.
  36.  
  37. DO NOT RENAME FIELDS.  DO NOT REMOVE THE BEGIN OR END MARKERS.  There
  38. are no longer any limits on the fields lengths, but please try to be
  39. short.
  40.  
  41. Complete as many fields as possible.  I strongly encourage developers to
  42. complete all the fields, as its more descriptive.  You must fill in at
  43. least the Title, Version, Entered-date, Description, and Primary-site fields.
  44.  
  45. Make any corrections to an existing entry that are necessary.  The
  46. initial data came from a variety of sources, and is not at all assumed
  47. to be correct.  Remember to update the Entered-date field if you update
  48. an existing entry.
  49.  
  50. Thank you VERY much for your time and enthusiasm.  Your contribution
  51. will help to ensure that the Linux Software Map will continue to be a
  52. trusted Linux resource.
  53.  
  54.  
  55. =============================================================================
  56. Lsmtool
  57. =============================================================================
  58.  
  59. I've written a small (and still fragile) tool to make it easier to
  60. browse and update the LSM.  It will only work on a new style database
  61. (09AUG94).  Find it on sunsite.unc.edu (I don't know yet where there).
  62. Filename is lsmtool-0.1.tar.gz.  Source only.
  63.  
  64.  
  65. =============================================================================
  66. As of the 09AUG94 version...
  67. =============================================================================
  68.  
  69. The 09AUG94 version of the template is a radical change from the syntax
  70. of earlier versions.  It is not upward compatible.  There are several
  71. reasons for the change:
  72.  
  73.     * no limits on line lengths
  74.     * less awkward multi-line format
  75.     * nicer method (for the user) for specifying the ftp site and
  76.       files
  77.     * one entry for all files comprising a package
  78.  
  79. The new version is identified by the "Begin3" line that starts it.
  80. Earlier versions had "Begin" and "Begin3".  Old versions will be
  81. accepted for a while, but please use the newest one to make things
  82. easier for me.
  83.  
  84.  
  85. =============================================================================
  86. The LSM Entry Form
  87. =============================================================================
  88.  
  89. The general syntax is now similar to that of netnews headers, i.e., a
  90. keyword (at the beginning of a line), a colon (with no spaces separating
  91. it from the keyword), and text that may be continued to the next line by
  92. starting each continuing line with whitespace (space, tab).  Empty lines
  93. are also allowed (unlike netnews).  Since fields may be several lines
  94. long, there is no longer a separate keyword for each line (we now have
  95. one "Description" keyword, where the older versions had "Desc1",
  96. "Desc2", and so on).
  97.  
  98. There are no limits on the line lenght or the number of lines for one
  99. keyword, but please try to be short, especially in the description.
  100. Don't put the whole README into the description, usually half a dozen
  101. of lines is more than enough.  Please keep each line (including keyword)
  102. below 80 characters for maximal viewing comfort.  Use a tab width of 8
  103. spaces, or don't use tabs at all.
  104.  
  105. Mandatory fields: Title, Version, Entered-date, Description, Primary-site.
  106.  
  107. Descriptions of the fields (an empty form is included at the end; use that
  108. to fill in).
  109.  
  110. PLEASE NOTE THAT THE "Begin3" AND "End" LINES ARE ESSENTIAL.  IF YOU
  111. REMOVE THEM, THE ENTRY WILL BE USELESS AND WILL REQUIRE MANUAL EDITING
  112. BY ME AND I DON'T WANT TO DO THAT.
  113.  
  114. Note that case is significant.
  115.  
  116. Begin3
  117. Title:        The name of the package.  Please use the same title for
  118.         the LSM entry of each version, so as to make it easier
  119.         to find entries for new versions of packages that already
  120.         have one in the data base.
  121. Version:    Version number or other designation.  Use a date if
  122.         nothing else is appropriate.
  123. Entered-date:    Date of when the LSM entry was last modified.  Note that
  124.         you should fill in both Version and Entered-date.
  125. Description:    Short description of the package.
  126. Keywords:    A short list of carefully selected keywords that describe
  127.         the package.
  128. Author:     Original author(s) of package.  In RFC822 format (i.e.,
  129.         something that will fit into a From: or To: header of a
  130.         normal Internet mail message).  Preferred format:
  131.  
  132.             mailname@site.domain.top (Full name)
  133.  
  134.         Other formats will be converted to this format, if time
  135.         and energy of LSM maintainer will allow it.
  136.         
  137.         Multiple persons may be given, one per line.
  138. Maintained-by:    Maintainer(s) of Linux port.  Same format as Author.
  139. Primary-site:    A specification of on which site, in which directory,
  140.         and which files are part of the package.  First line
  141.         gives site and base directory, the rest give the sizes
  142.         and names of all files.  Names are either relative to
  143.         the base directory, or full pathnames.  If the ftp
  144.         site does not use Unix style pathname syntax, then
  145.         the full pathname must be given every time.  The pathname
  146.         must not contain spaces.  Example:
  147.  
  148.             Primary-site: sunsite.unc.edu /pub/Linux/docs
  149.                       10kB lsm-1994.01.01.tar.gz
  150.                       997  lsm-template
  151.                       22 M /pub/Linux/util/lsm-util.tar.gz
  152.  
  153.         The file size may be given in bytes (no suffix), kilobytes
  154.         (k, kb), or megabytes (M, MB).  The suffix may be separated
  155.         with spaces, and may be in upper case or lower case.  The
  156.         size can be left off.
  157.  
  158.         For very large packages that are contained within
  159.         one directory (say, a distribution), only the directory
  160.         need be listed.  Adding a trailing slash makes it clear
  161.         that it is a directory.
  162.  
  163.         The filename should be the final location, not an
  164.         "incoming" directory.  If you don't know the final
  165.         location, at least make a good guess (since files _will_
  166.         be moved from incoming, it is not a good guess).
  167. Alternate-site: One alternate site may be given.  It should not be a
  168.         site that mirrors the primary site (these are best
  169.         found from a list of mirror sites), but should be one
  170.         that maintained separately.  More sites carrying the
  171.         package can be found using Archie.  The syntax is
  172.         the same as for Primary-site, but if there is only one
  173.         line (i.e., no files are specified), they are assumed
  174.         to be the same as for Primary-site.
  175.  
  176.             Alternate-site: ftp.funet.fi /pub/OS/Linux/doc/lsm
  177.             Alternate-site: foo.bar /pub/lsm
  178.                     11 kB lsm-1994-01-01.cpio.Z
  179.                     0.1 kB lsm-template.Z
  180.                     22 MB lsm-util.tar.gz
  181.  
  182. Original-site:    The original package, if this is a port to Linux.  Syntax
  183.         is as in Primary-site, with the same handling of missing
  184.         filenames as in Alternate-site.
  185. Platforms:    Software or hardware that is required, if unusual.  A
  186.         C compiler or floppy disk would not be unusual, but a
  187.         Python interpreter or tape drive probably would be.  If
  188.         the requirements are evident from the description, it
  189.         need not be repeated here.
  190. Copying-policy:    Copying policy.  Use "GPL" for GNU Public License,
  191.         "BSD" for the Berkeley style of copyright, "Shareware"
  192.         for shareware, and some other description for other
  193.         styles of copyrights.  If the use or copying requires
  194.         payment, it must be indicated.
  195. End
  196.  
  197.  
  198. =============================================================================
  199. IAFA
  200. =============================================================================
  201.  
  202. The IAFA (Internet Anonymous Ftp Archives) have a form similar to LSM
  203. for specifying similar information about files.  The 24JUL94 version of
  204. LSM is much more close to the IAFA format, but is still not quite the
  205. same.
  206.  
  207. Straight IAFA is not suitable for LSM.  It only allows one filename
  208. (many packages consist of several files).  It is also awkward because it
  209. specifies different formats for records for different types of files.
  210.  
  211. (This information is based on a draft version of a description on the
  212. iafa format from the iafa work group.  The draft is dated 92.06.10; it
  213. was the newest I could find, but if there are any newer ones with
  214. significant changes, please send me information.)
  215.  
  216. However, this revision of the LSM format tries to be as close to iafa as
  217. possible.  The major differences are:
  218.  
  219.     * Package-name, Document-name, and Dataset-name are
  220.       converted to one Primary-site (with site and location taken
  221.       from Maintained-at, if given, or filled in by LSM maintainer).
  222.     * Field names "Author" and "Revision-date" converted to "Authors"
  223.       and "Version".
  224.     * Other fields are added to the database as is.
  225.     * Added fields: primary-site, alternate-site, original-site,
  226.       entered-date, checked-date, and checked-status.
  227.     * an LSM template _must_ begin with "Begin3" and end with "End",
  228.       with both delimiters being the only things on the line (except
  229.       for trailing whitespace), and must be at the beginning of the
  230.       line.  This is to make it easier to automatically extract them
  231.       from news articles and such.
  232.     * fields in an LSM entry can be in whatever order
  233.  
  234. We only support iafa records for packages, documents and datasets.
  235.  
  236.  
  237.  
  238. =============================================================================
  239. Empty Template
  240. =============================================================================
  241.  
  242. Cut this out, fill it in, send it to me.
  243.  
  244. Begin3
  245. Title:          
  246. Version:        
  247. Entered-date:   
  248. Description:    
  249. Keywords:       
  250. Author:         
  251. Maintained-by:  
  252. Primary-site:   
  253. Alternate-site: 
  254. Original-site:  
  255. Platform:       
  256. Copying-policy: 
  257. End
  258.